View Javadoc

1   /*
2    * Copyright (c) 2004-2005, University Health Network.  All rights reserved. Distributed under the BSD 
3    * license (see http://opensource.org/licenses/bsd-license.php).
4    *  
5    * Created on 29-Nov-2004
6    */
7   package ca.uhn.cache.proxy;
8   
9   import ca.uhn.cache.IDataItem;
10  
11  /***
12   * A <code>IDataInspector</code> is a helper that knows about a certain result 
13   * class and is able to tell a <code>ISemanticCache</code> important things 
14   * about results of that class.   
15   * 
16   * @author <a href="mailto:bryan.tripp@uhn.on.ca">Bryan Tripp</a>
17   * @version $Revision: 1.1 $ updated on $Date: 2005/01/24 22:53:24 $ by $Author: bryan_tripp $
18   */
19  public interface IDataInspector {
20  
21      /***
22       * Wraps a domain-specific value (a query result) with metadata that are 
23       * useful for caching.  
24       * 
25       * @param theDataVaue a piece of data (to be cached, in cache, etc)
26       * @return a <code>IDataItem</code> that wraps this value with extra metadata
27       */
28      public IDataItem wrap(Object theDataVaue);
29      
30  }